Skip to content

Improve dev docs #498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Lorak-mmk merged 3 commits into from
Jul 8, 2025
Merged

Improve dev docs #498

Lorak-mmk merged 3 commits into from
Jul 8, 2025

Conversation

@Lorak-mmk
Copy link

@Lorak-mmk Lorak-mmk commented Jul 7, 2025

This PR make a few small improvements for contributor docs:

  • First commit removed README-dev, splitting its contents between new MAINTENANCE.md and existing CONTRIBUTING.md. This is the structure we have in Rust Driver. I feel that this is a more natural division (README - users, CONTRIBUTING - developers, MAINTENANCE - maintainers), but I don't have very strong feelings about this, so I can reverse this change if reviewers dislike it.
  • Second commit is mostly stylistic, bumping Scylla versions in commands in CONTRIBUTING.md, and switching one ccm command from C* to Scylla
  • Third commit is important one for contributors imo. Building extensions can take a long time, making developing more frustrating. This effect is pretty much fully negated by using C/C++ compiler caching like ccache. In my case, it takes rebuild time from ~90 seconds to ~1-2 seconds, so I think it is important to recommend using such a tool in contributor guildelines.

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes. no features / bug fixes
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce. no new items
  • I have adjusted the documentation in ./docs/source/. no code changes
  • I added appropriate Fixes: annotations to PR description. - no issue for that

Lorak-mmk added 3 commits July 7, 2025 12:07
@Lorak-mmk
Split README-dec into CONTRIBUTING and MAINTENANCE
eb21975 
It was quite weird to have both CONTRIBUTING and README-dev.
Most of README-dev fits well into CONTRIBUTING. The sections about
releasing deserves its own MAINTENANCE document, similarly to how it is
done in Rust Driver.
@Lorak-mmk
CONTRIBUTING: Adjust commands to Scylla
d8ed0ff 
Gets rid of some Cassandra leftovers, and updates some mentioned Scylla
versions.
@Lorak-mmk
CONTRIBUTING: Recommend ccache/sccache
3ead907 
Those tools dramatically speed up building of the driver, making
contributor life much easier.
@Lorak-mmk Lorak-mmk self-assigned this Jul 7, 2025
fruch
fruch approved these changes Jul 8, 2025
View reviewed changes
Copy link

@fruch fruch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Lorak-mmk Lorak-mmk merged commit a92d714 into scylladb:master Jul 8, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fruch fruch fruch approved these changes

@sylwiaszunejko sylwiaszunejko sylwiaszunejko approved these changes

@dkropachev dkropachev Awaiting requested review from dkropachev

Assignees

@Lorak-mmk Lorak-mmk

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Lorak-mmk @fruch @sylwiaszunejko